Body parameters

This section details the body parameters, taking into account the structuring within the query.

Id

Parameter	Data type	Description	Valid Values
`id`	int	The patient's identification should be provided as an integer value.	Range: 0-999999

Format in query:

[{
  "idx":  35
}]

Age

⚠️ Mandatory field

Parameter	Data type	Description	Valid Values
`age`	int	The patient's age should be provided as an integer value.	Range: 0-130

Format in query:

[{
  "age":  35
}]

Sex

⚠️ Mandatory field

Parameter	Data type	Description	Valid Values
`sex`	str	Patient gender must be indicated as either 'female' (F) or 'male' (M).	F, M

Format in query:

[{
  "sex": "M"
}]

Inpatient Admissions

⚠️ Mandatory field

Parameter	Data type	Description	Valid Values
`inpatientAdmissions`	int	The number of admissions to the inpatient ward from the last 2 years.	Range: 0-200

Format in query:

[{
  "inpatientAdmissions": 4
}]

Emergency Admissions

⚠️ Mandatory field

Parameter	Data type	Description	Valid Values
`emergencyAdmissions`	int	The number of admissions to the emergency department from the last 2 years.	Range: 0-500

Format in query:

[{
  "emergencyAdmissions": 1
}]

Stay Days

⚠️ Mandatory field

Parameter	Data type	Description	Valid Values
`stayDays`	int	Number of days of hospital stay from the last 2 years.	Range: 0-4000

Format in query:

[{
  "stayDays": 14
}]

Weights

Parameter	Data type	Description	Valid Values
`date`	datetime	The date of the weights recorded. Only weights from the last 2 years. Accepts American format, European format, or European format with slashes.	YYYY-mm-dd, DD-MM-YYYY, DD/MM/YYYY
`weights`	float	Records the weight of the patient during different measurements.	Range: 20.0-202.0

Format in query:

[{
  "weights": [{
      "date": "25-08-2023",
      "value": 75.0
    }]
}]

BMI

Parameter	Data type	Description	Valid Values
`date`	datetime	The date of the BMI recorded. Only BMIs from the last 2 years. Accepts American format, European format, or European format with slashes.	YYYY-mm-dd, DD-MM-YYYY, DD/MM/YYYY
`bmi`	float	Body Mass Index of the patient.	Range: 10-150

Format in query:

[{
  "bmi": [{
      "date": "25-08-2023",
      "value": 22.5
    }]
}]

ICD (International Classification of Diseases) Codes

⚠️ Mandatory field

The ICD (International Classification of Diseases) codes are alphanumeric codes that classify various diseases and health conditions. These codes provide a standardized system for healthcare professionals to document and categorize specific diagnoses.

The ICD codes we receive can be ICD-9 or ICD-10. Queries containing ICD-9 and ICD-10 codes can be submitted** interchangeably, and we will treat and process this mix of codes appropriately later.

Below are some examples of ICD-9 and ICD-10 codes, along with a brief description of each:

ICD-9 Examples codes:

366.9: Unspecified cataract.
457.2: Postmastectomy lymphedema syndrome.
293.0: Delirium due to conditions classified elsewhere.
787.20: Dysphagia, unspecified.

ICD-10 Examples codes:

I63.311: Cerebral infarction due to unspecified occlusion or stenosis of the right carotid artery.
J03.221: Streptococcal pharyngitis.
Z51.5: Palliative care involving the use of respiratory support.
I11.0: Hypertensive heart disease with heart failure.

Parameter	Data type	Description	Valid Values
`date`	datetime	The date the diagnosis was recorded. Only diagnoses from the last 2 years. Accepts American format, European format, or European format with slashes.	YYYY-mm-dd, DD-MM-YYYY, DD/MM/YYYY
`value`	str	The ICD code of the diagnosis.	e.g., "366.9", "I11.0"
`version`	int	The version of the ICD code (9 for ICD-9, 10 for ICD-10).	9, 10

Format in query:

[{
  "icd": [{
          "date": "31-10-2022",
          "value": "366.9",
          "version": 9
        },
         {
          "date": "14-09-2024",
          "value": "R069010",
          "version": 10
        }]
 }]

tip

Please note that to ensure the ICD-9 and ICD-10 codes validity, the dates of admission and discharge should be before or equal to the current date. On the other hand, it is necessary to send ICD codes divided into primary and secondary codes for each patient care.

ATC (Anatomical Therapeutic Chemical) Codes

⚠️ Mandatory field

The ATC (Anatomical Therapeutic Chemical) codes are alphanumeric codes used to classify pharmaceutical substances. These codes provide a standardized system for categorizing medications based on their therapeutic and chemical properties. Below are some examples of ATC codes, along with a brief description of each:

N02BE: Other analgesics and antipyretics, non-opioids.
J01CR: Combinations of penicillins, including beta-lactamase inhibitors.
B05BA: Amino acids and derivatives.
N03AX: Other antiepileptic.

Parameter	Data type	Description	Valid Values
`date`	datetime	The date the ATC code was recorded. Only ATC codes from the last 2 years. Accepts American format, European format, or European format with slashes.	YYYY-mm-dd, DD-MM-YYYY, DD/MM/YYYY
`value`	str	The ATC code of the pharmaceutical substance.	e.g., "N02BE", "J01CR", "B05BA", "N03AX"

Format in query:

[{
  "atc": [{
          "date": "10-14-2023",
          "value": "A10AE"
        },
        {
          "date": "14-09-2024",
          "value": "B05BB"
        }]
}]

tip

Please note that all the provided ATC codes have the required minimum of 5 digits. Additionally, these codes are intended for the classification of pharmaceutical substances and should not be used for any other purpose. WHO Collaborating Centre for Drug Statistics Methodology - ATC/DDD Index

Barthel Index

The Barthel Index is an ordinal scale used to measure functional independence in patients with chronic, disabling conditions, particularly in rehabilitation settings. It comes in two versions: the original 10-item form and the expanded 15-item version. The 10-item version is more commonly used and assesses independence in various activities related to personal care and mobility. Each item is scored based on the level of independence, and the total score reflects the overall level of independence.

Activities and Scores

Parameter	Data type	Description	Valid Values
`date`	datetime	Date on which the Barthel code was recorded. Only Barthels from the last 2 years. Accepts American format, European format, or European format with slashes.	YYYY-mm-dd, DD-MM-YYYY, DD/MM/YYYY
`feeding`	int	Feeding	0 = unable / 5 = needs help or modified diet / 10 = independent
`bathing`	int	Bathing	0 = dependent / 5 = independent (or in shower)
`grooming`	int	Grooming	0 = needs help with personal care / 5 = independent with implements provided
`dressing`	int	Dressing	0 = dependent / 5 = needs help but can do about half unaided / 10 = independent
`bowels`	int	Bowels	0 = incontinent or needs enemas / 5 = occasional accident / 10 = continent
`bladderControl`	int	Bladder	0 = incontinent, or catheterized and unable to manage alone / 5 = occasional accident / 10 = continent
`toiletUse`	int	Toilet Use	0 = dependent / 5 = needs some help, but can do something alone / 10 = independent
`chairTransfers`	int	Transfers (bed to chair and back)	0 = unable, no sitting balance / 5 = major help, can sit / 10 = minor help / 15 = independent
`mobility`	int	Mobility (on level surfaces)	0 = immobile or < 50 yards / 5 = wheelchair independent, including corners, >50 yards / 10 = walks with help of one person >50 yards / 15 = independent with aid >50 yards
`stairClimbing`	int	Stairs	0 = unable / 5 = needs help / 10 = independent
`total`	int	Total	The overall Barthel screening score.

The total score is obtained by summing the scores of all the items, with higher scores indicating higher levels of independence. The Barthel Index is valuable for assessing disability and monitoring changes in disability over time.

Format in query:

[{
  "barthel": [{
      "date": "25-08-2024",
      "toiletUse": 10,
      "bathing": 5,
      "feeding": 10,
      "dressing": 10,
      "bowels": 0,
      "chairTransfers": 5,
      "mobility": 15,
      "grooming": 5,
      "bladderControl": 10,
      "stairClimbing": 10,
      "total": 80
    }]
 }]

MNA

The MNA® is a validated nutrition screening and assessment tool that can identify geriatric patients age 65 and above who are malnourished or at risk of malnutrition. The MNA® has developed nearly 20 years ago and is the most well-validated nutrition screening tool for the elderly. Originally comprised of 18 questions, the current MNA® now consists of 6 questions and streamlines the screening process. The current MNA® retains the validity and accuracy of the original MNA® in identifying older adults who are malnourished or at risk of malnutrition. The revised MNA® Short Form makes the link to intervention easier and quicker and is now the preferred form of the MNA® for clinical use. MNA (Mini Nutritional Assessment) Website

caution

Please make sure to follow the guidelines below to ensure a successful and accurate query in the evaluation of the MNA scale. If the fields and values are sent in a different way than specified in the table or if the values are outside the set range, the API will return a formatting error (the types of errors are explained in a later section). In addition, if the data types sent do not match those specified in the table, an error will also be generated.

Parameter	Data type	Description	Valid Values
`date`	datetime	The date of the MNA evaluation. Only MNAs from the last 2 years. Accepts American format, European format or European format with slashes	YYYY-mm-dd, DD-MM-YYYY, DD/MM/YYYY
`bmi`	int	Body mass index (BMI) is a measure of body fat based on weight in kg divided by height in m2.	0, 1, 2, 3
`reduceFoodIntake`	int	Assesses if there is a reduction in food intake.	0, 1, 2
`weightLoss`	int	Measures recent weight loss, which can indicate malnutrition.	0, 1, 2, 3
`mobility`	int	Assesses the patient's mobility and ability to move around.	0, 1, 2
`acuteDisease`	int	Determines if the patient has any acute diseases or medical conditions.	0, 2
`neuropsychologicalProblems`	int	Assesses for any neuropsychological problems, such as cognitive issues or mental health.	0, 1, 2
`autonomousLiving`	int	Measures the patient's ability to live independently.	0, 1
`medication`	int	Assesses if the patient is on any medications that may affect their nutritional status.	0, 1
`pressureSores`	int	Determines the presence of pressure sores, indicating possible malnutrition and immobility.	0, 1
`foodIntake`	int	Assesses overall food intake.	0, 1, 2
`proteinIntake`	float	Measures the patient's protein intake.	0.0, 0.5, 1.0
`fruitAndVegetables`	int	Assesses the consumption of fruits and vegetables.	0, 1
`fluidIntake`	float	Measures the patient's fluid intake.	0.0, 0.5, 1.0
`feedingMode`	int	Determines the patient's feeding mode.	0, 1, 2
`selfNutritionalStatus`	int	Assesses the patient's self-perceived nutritional status.	0, 1, 2
`healthStatus`	float	Measures the patient's overall health status.	0.0, 0.5, 1.0, 2.0
`armCircumference`	float	Measures the patient's arm circumference, indicating muscle mass and malnutrition.	0.0, 0.5, 1.0
`calfCircumference`	int	Measures the patient's calf circumference, indicating muscle mass and malnutrition.	0, 1
`total`	float	The overall MNA screening score obtained by adding up the scores from each parameter.	Range: 0.0-31.0

Format in query:

[{
  "mna": [{
    "date": "11-07-2024",
    "reduceFoodIntake": 2,
    "weightLoss": 2,
    "mobility": 0,
    "acuteDisease": 2,
    "neuropsychologicalProblems": 1,
    "bmi": 1,
    "autonomousLiving": 0,
    "medication": 0,
    "pressureSores": 0,
    "foodIntake": 0,
    "proteinIntake": 0,
    "fruitAndVegetables": 0,
    "fluidIntake": 0,
    "feedingMode": 0,
    "selfNutritionalStatus": 0,
    "healthStatus": 0,
    "armCircumference": 0,
    "calfCircumference": 0,
    "total": 8.0
  }]
}]

Emina

The Emina Scale assessment evaluates different aspects related to a patient's activity level, mental state, environmental conditions, mobility, and nutritional status. Each parameter is scored on a scale from 0 to 3, and the overall Emina score provides an assessment of the patient's condition.

caution

Please make sure to follow the guidelines below to ensure a successful and accurate query in the evaluation of the Emina scale. If the fields and values are sent in a different way than specified in the table or if the values are outside the set range, the API will return a formatting error (the types of errors are explained in a later section). In addition, if the data types sent do not match those specified in the table, an error will also be generated.

Parameter	Data type	Description	Valid Values
`date`	datetime	The date of the Emina evaluation. Only Eminas from the last 2 years. Accepts American format, European format or European format with slashes	YYYY-mm-dd, dd-mm-YYYY or dd/mm/YYYY
`activity`	int	Assesses the patient's activity level.	0: Bedridden or immobile 1: Limited activity 2: Moderate activity 3: Active
`mentalState`	int	Measures the patient's mental state and cognitive function.	0: Confused or disoriented 1: Forgetfulness or mild cognitive impairment 2: Alert and oriented
`humidity`	int	Assesses the humidity level in the patient's environment.	0: Poor humidity conditions 1: Moderate humidity conditions 2: Good humidity conditions 3: Excellent humidity conditions
`mobility`	int	Measures the patient's mobility and ability to move around.	0: Completely immobile or bedridden 1: Limited mobility 2: Moderate mobility 3: Independent mobility
`nutrition`	int	Assesses the patient's nutritional status.	0: Severely malnourished 1: Moderately malnourished 2: Mildly malnourished 3: Well-nourished
`total`	int	The overall Emina score obtained by adding up the scores from each parameter.	Range: 0-15

Format in query:

[{
  "emina": [{
    "date": "11-07-2024",
    "mentalState": 0,
    "mobility": 3,
    "humidity": 3,
    "nutrition": 1,
    "activity": 3,
    "total": 10
  }]
}]

Canadian Scale

The Canadian Scale is an assessment tool used to measure functional independence in patients with chronic, disabling conditions, particularly in rehabilitation settings. It evaluates various aspects related to a patient's level of consciousness, orientation, speech, facial movements, and mobility in the arms and legs. Each parameter is scored based on specific values, and the overall Canadian Scale score reflects the patient's level of functional independence.

caution

Please make sure to follow the guidelines below to ensure a successful and accurate query in the evaluation of the Canadian scale. If the fields and values are sent in a different way than specified in the table or if the values are outside the set range, the API will return a formatting error (the types of errors explained in a later section). In addition, if the data types sent do not match those specified in the table, an error will also be generated.

Parameter	Data type	Description	Valid Values
`date`	datetime	The date of the Canadian Scale assessment. Only Canadian Scale from the last 2 years. Accepts American format, European format or European format with slashes	YYYY-mm-dd, dd-mm-YYYY or dd/mm/YYYY
`conscience`	float	Assesses the patient's level of consciousness.	1.5, 3.0
`orientation`	int	Measures the patient's level of orientation.	0, 1
`speech`	float	Assesses the patient's speech abilities.	0.0, 0.5, 1.0
`face`	float	Measures the patient's facial movements.	0.0, 0.5
`armProximal`	float	Assesses the patient's proximal arm movements.	0.0, 0.5, 1.0, 1.5
`armDistal`	float	Measures the patient's distal arm movements.	0.0, 0.5, 1.0, 1.5
`leg`	float	Assesses the patient's leg movements.	0.0, 0.5, 1.0, 1.5
`deficitFace`	float	Measures the presence of deficits in facial movements.	0.0, 0.5
`deficitArms`	float	Assesses the presence of deficits in arm movements.	0.0, 1.5
`deficitLegs`	float	Measures the presence of deficits in leg movements.	0.0, 1.5
`total`	float	The overall score obtained from the Canadian Scale assessment.	0.0 - 10.0

Format in query:

[{
  "canadianScale": [{
    "date": "25-12-2023",
    "conscience": 3,
    "orientation": 0,
    "speech": 1,
    "face": 0,
    "armProximal": 0,
    "armDistal": 0,
    "leg": 1,
    "deficitFace": 0,
    "deficitArms": 0,
    "deficitLegs": 0,
    "total": 6.0
  }]
}]

LabResults

The LabResults include the structured data of laboratory tests conducted. Each entry encapsulates essential information regarding a specific test, including the date the test was conducted, the name of the test, the LOINC code where applicable and the result value. Using LOINC codes facilitates a standardized representation and interoperability of the lab data across different systems, ensuring that the conveyed information remains precise and consistent.

caution

Please make sure to follow the guidelines below to ensure a successful and accurate query in the evaluation of lab results. Laboratory results should be recorded according to LOINC codes as specified. If the healthcare facility sends a laboratory test that does not correspond to any LOINC code, the name of the test should be specified without a code. If the fields and values are sent differently than specified in the table or if the values are outside the set range, the API will return a formatting error (the types of errors are explained in a later section).

Parameter	Data type	Description	Valid Values
`date`	datetime	The date the test was conducted. Only tests from the last 2 years. Accepts American format, European format or European format with slashes	YYYY-mm-dd, DD-MM-YYYY, DD/MM/YYYY
`name`	str	Name of the laboratory test. If the test corresponds to a LOINC code, include it in square brackets following the test name.	e.g., "Acetylcholine [Mass/volume] in Serum"
`loinc`	str	The LOINC code corresponding to the laboratory test. If no LOINC code is available, this field should be left empty.	e.g., "1707-9"
`value`	float	The result value of the laboratory test.	Varies based on test

Format in query:

[{
  "labs": [{
    "date": "11-18-2023",
    "name": "Acetylcholine [Mass/volume] in Serum",
    "loinc": "1707-9",
    "value": 3.0
  },
  {
    "date": "07-20-2024",
    "name": "TotalBilirubinSerum",
    "loinc": "",
    "value": 5.0
  }]
}]

Center

⚠️ Mandatory field

Parameter	Data type	Description	Valid Values
`center`	string	Hospital from where the consultation takes place	e.g., "Hospital de Mataró"

Format in query:

[{
  "center":  "Hospital de Mataró"
}]

Id​

Format in query:​

Age​

Format in query:​

Sex​

Format in query:​

Inpatient Admissions​

Format in query:​

Emergency Admissions​

Format in query:​

Stay Days​

Format in query:​

Weights​

Format in query:​

BMI​

Format in query:​

ICD (International Classification of Diseases) Codes​

Format in query:​

ATC (Anatomical Therapeutic Chemical) Codes​

Format in query:​

Barthel Index​

Activities and Scores​

Format in query:​

MNA​

Format in query:​

Emina​

Format in query:​

Canadian Scale​

Format in query:​

LabResults​

Format in query:​

Center​

Format in query:​

Id

Format in query:

Age

Format in query:

Sex

Format in query:

Inpatient Admissions

Format in query:

Emergency Admissions

Format in query:

Stay Days

Format in query:

Weights

Format in query:

BMI

Format in query:

ICD (International Classification of Diseases) Codes

Format in query:

ATC (Anatomical Therapeutic Chemical) Codes

Format in query:

Barthel Index

Activities and Scores

Format in query:

MNA

Format in query:

Emina

Format in query:

Canadian Scale

Format in query:

LabResults

Format in query:

Center

Format in query: